filtergc - Potassium

function filtergc(filterType: string, filterOptions: table, filterOne: boolean): {any} | any?

string

required

The specific type to filter for. “function” or “table” are the only accepted strings. Each filter type has it’s own filter options.

Filter options. See corresponding usage in example below.

boolean

Boolean indicating whether to return a singular object.

Field	Type	Description
IgnoreExecutor	boolean	Whether to ignore executor-created functions.
Name	string	The name of the function.
Hash	string	The function hash.
Environment	table	The environment table to match.
StartLine	number	The line number of the function.
Constants	table	A list of constants the function must contain.
Upvalues	table	A list of upvalues the function must contain.

Field	Type	Description
Keys	table	A list of keys the table must contain.
Values	table	A list of values the table must contain.
KeyValuePairs	table	A dictionary of key-value pairs the table must match.
Metatable	table	The metatable the table must have.

Example function filter

local function exampleFunction()
    return "Hello, world!"
end

local filterOptions = {
    IgnoreExecutor = false,
    Name = "exampleFunction"
}

local result = filtergc("function", filterOptions, true)
print(exampleFunction == found) --> true
print(result()) --> Hello, world!

Example table filter

local myTable = {
    ["myKey"] = 123456
}

local filterOptions = {
    Keys = { "myKey" }
}

local found = filtergc("table", filterOptions, true)
print(found == myTable) --> true
print(found.myKey) --> 123456

​Function filter options

​Table filter options

​Example function filter

​Example table filter

Function filter options

Table filter options

Example function filter

Example table filter